Enhance API Reference - Documentation improvements #410
Conversation
| @@ -123,7 +123,7 @@ export class FungibleToken implements FungibleTokenCore, StorageManagement, Fung | |||
| // Get the unused amount from the `ft_on_transfer` call result. | |||
| let unused_amount: Balance; | |||
| try { | |||
| const promise_result = near.promiseResult(0).replace(/"*/g, ''); //TODO: why promiseResult returnes result with brackets? | |||
| const promise_result = near.promiseResult(0).replace(/"*/g, ''); //TODO: why promiseResult returns result with brackets? | |||
There was a problem hiding this comment.
FT standard defined the encoding for the input/outputs as JSON. Since JSON does not support big integers, the FT standard uses a string type to pass the unused_amount. It would be cleaner to use JSON.parse() instead of manually "parsing" quotes out.
There was a problem hiding this comment.
@frol, this is out of this PR's scope, would be better in a separate PR
| * @call({}) | ||
| * ft_on_transfer({ sender_id, amount, msg }: { | ||
| sender_id: AccountId; | ||
| amount: number; | ||
| msg: String; | ||
| }): PromiseOrValue<number> { | ||
| return this.token.ft_on_transfer({ sender_id, amount, msg }); | ||
| }; | ||
| * } |
There was a problem hiding this comment.
Formatting is broken here, and in a few other places in the doc string examples. Please, fix them
| * import { | ||
| FungibleTokenCore, | ||
| FungibleTokenResolver, | ||
| FungibleToken, | ||
| * } from "near-contract-standards/lib" |
|
@gtsonevv Thank you for your contribution! Your pull request is now a part of the Race of Sloths! Current status: executed
Your contribution is much appreciated with a final score of 5! What is the Race of SlothsRace of Sloths is a friendly competition where you can participate in challenges and compete with other open-source contributors within your normal workflow For contributors:
For maintainers:
Feel free to check our website for additional details! Bot commands
|
Pre-flight checklist
Motivation
Test Plan
Related issues/PRs